OpenEdge Getting Started:<br />WebSpeed Essentials ubroker.properties file

The ubroker.properties file is the property file for the WebSpeed Transaction Server, WebSpeed Messengers, and the NameServer. All values that define instances of the WebSpeed Transaction Server and the NameServer are stored within this file. The command-line utilities and the Progress Explorer access this information through the AdminServer when working with instances of all processes.

The ubroker.properties file resides in the install-path/properties directory. It is a fully commented file containing information relevant to setting properties for your WebSpeed configuration.

From a Windows machine, you use the Progress Explorer to create and configure instances of the WebSpeed Transaction Server or the NameServer on the Windows platform or remote UNIX platforms. It is possible to edit the ubroker.properties file manually. See the "Editing the ubroker.properties file" section for more information. Advanced users can also use the mergeprop utility to apply changes to the ubroker.properties file. For more information on the mergeprop utility, see the chapter on managing OpenEdge property files in OpenEdge Getting Started: Installation and Configuration .

The ubroker.properties file consists of a hierarchical structure of configuration entities, where parent entities provide configuration information that you can override or extend in each child entity. Each configuration entity has a name that begins the entity definition, and the definition contains configuration settings for one or more product instances. When configuring your WebSpeed environment, you work most often with the [UBroker], [UBroker.WS], [NameServer], [WebSpeed], and [WebSpeed.Messengers] configuration entities.

Editing the ubroker.properties file

You can edit ubroker.properties directly using any text editor to create new WebSpeed Transaction Server and NameServer configurations or edit existing configurations. The simplest way to make new configurations in the ubroker.properties file is to copy an existing Transaction Server or NameServer definition and then modify the values of the copy’s properties to suit your needs. When you do this, you must be sure to supply each definition with its own uuid setting, as described in the list of required unique parameters later in this section.

From a Windows machine, you can also use the Progress Explorer remotely to create and configure instances of the WebSpeed Transaction Server or the NameServer on the UNIX platform.

If you edit the configuration using a text editor, without the Progress Explorer, note that:

The ubroker.properties file resides in the /properties subdirectory of the OpenEdge installation directory.

You should not directly change the values in the ubroker.properties file unless you have a complete understanding of how the changes affect WebSpeed components. If you have the Progress Explorer available from a remote Windows machine, use it to make all changes to this file on your UNIX machines.

For complete definitions of all the properties and detailed information on how to set them, see the install-dir\properties\ubroker.properties.README file.

If you create additional instances of the WebSpeed Transaction Server and the NameServer, you must be sure that each of the following parameters has a value unique to the entire ubroker.properties file:

[Ubroker.WS.broker-name] — The Transaction Server name must be unique.

portNumber — Each Transaction Server configuration requires a unique port number.

defaultService — You can only set one default service on each NameServer. If you configure two WebSpeed Transaction Servers to use the same NameServer and specify that the Transaction Servers perform the same application service, the Transaction Servers must also support the same business function.

appserviceNameList — A list of aliases that can be used in the WService=<appservice-name> in the URL.

uuid — A universally unique identifier for a Transaction Server. If you use the Progress Explorer to create the new Transaction Server, this property is automatically set. If you manually add Transaction Server definitions, generate a unique uuid for each Transaction Server definition by using the following command:


`install-path`\bin\genuuid

You can then enter that value in the file.

Log files — Each Transaction Server configuration and NameServer configuration generates its own log files; the names must be unique for each Transaction Server and each NameServer.

If you create additional instances of the WebSpeed Transaction Server and the NameServer by copying an existing instance, be sure that each of the following parameters has the correct values for the new instance:

srvrStartupParam — Identify the startup parameters for your agents. Copy the value from the ubroker.properties file’s [UBroker.WS] section to your new Transaction Server definition, and modify.

controllingNameServer — Make sure that each Transaction Server points to its controlling NameServer.

userName and groupName — You can optionally specify a username and a group name that the Transaction Server runs under; if you do not specify these names, the Transaction Server runs under the username and group name of the user who starts the AdminServer.

Note: If you install the NameServer on a separate host from the WebSpeed Transaction Server, the NameServer installation includes its own copy of the properties file. You also must configure WebSpeed to use a remote NameServer.

You must ensure that all related properties and sections of the file are properly specified for each Transaction Server or NameServer instance. If you do edit the file directly, use the appropriate configuration utility (NSCONFIG or WSCONFIG) to validate the product configuration that you have edited. For more information on utilities, see the "WebSpeed command-line utilities" section or the section on the NSCONFIG utility in OpenEdge Application Server: Administration .